Skip to content

[jaxrs] Support jackson option (true by default) #22169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Oct 27, 2025
Merged

[jaxrs] Support jackson option (true by default) #22169

merged 4 commits into from
Oct 27, 2025

Conversation

@rignicat
Copy link
Contributor

@rignicat rignicat commented Oct 17, 2025 •
edited by wing328
Loading

Jackson was a requirement when using the server JAX-RS generator. Removing this requirement allows generating multi-platform code.

The PR is split into 3 commits (with a 4th for updating the samples/docs):

  1. Allow enabling/disabling jackson, since it was always enabled
  2. Disabled generating RootResource and RootApplication if generating interfaces, since these files make no sense in the context of generating interfaces
  3. Update templates to remove jackson references when disabled

The 2nd can be its own PR if required, since not directly relevant to the linked issue. But its a small change and something that makes no sense as it was, so I just added it instead of having to get a reviewer's attention twice.

To fix #6881

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples: 
    ./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request. - @martin-mfg Are you the correct person for this?

@rignicat rignicat mentioned this pull request Oct 17, 2025
Closed
@wing328
Copy link
Member

wing328 commented Oct 18, 2025

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@wing328
Copy link
Member

wing328 commented Oct 18, 2025

please also review the build failure when you've time

@rignicat rignicat force-pushed the remove-jackson-requirement branch from 5a04806 to e292bfb Compare October 20, 2025 07:07
@rignicat rignicat force-pushed the remove-jackson-requirement branch from e292bfb to f767c7b Compare October 20, 2025 07:44
@rignicat
Copy link
Contributor Author

rignicat commented Oct 20, 2025 •
edited
Loading

@wing328 Done, re-added one import statement in the template that shouldn't have been removed.

wing328
wing328 reviewed Oct 20, 2025
View reviewed changes
...nerator/src/main/java/org/openapitools/codegen/languages/AbstractJavaJAXRSServerCodegen.java
convertPropertyToStringAndWriteBack(CodegenConstants.IMPL_FOLDER, this::setImplFolder);
convertPropertyToBooleanAndWriteBack(USE_BEANVALIDATION, this::setUseBeanValidation);
convertPropertyToBooleanAndWriteBack(USE_TAGS, this::setUseTags);
convertPropertyToBooleanAndWriteBack(JACKSON, this::setJackson);
Copy link
Member

@wing328 wing328 Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about defaulting this option to true instead?

(I can do it in another PR instead)

Copy link
Contributor Author

@rignicat rignicat Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the value is set to default true here

I assumed the property, if not explicitly configured, would not be present (and this method does not set anything if the property is not present). Is this okay or is this an incrrect assumption?

Copy link
Member

@wing328 wing328 Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you're right. I was not expecting so many changes to the samples if the option is default to true but it turns out most changes are just removing empty lines

i'll test the option locally and merge if no question from me.

@wing328
Copy link
Member

wing328 commented Oct 20, 2025

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

@wing328 wing328 added this to the 7.17.0 milestone Oct 20, 2025
@wing328
Copy link
Member

wing328 commented Oct 20, 2025

circleici failure (aws outage?) not related to this change

@wing328 wing328 changed the title Remove jackson requirement, fixes #6881 Remove jackson requirement Oct 27, 2025
@wing328 wing328 changed the title Remove jackson requirement [jaxrs] Remove jackson requirement Oct 27, 2025
@wing328 wing328 changed the title [jaxrs] Remove jackson requirement [jaxrs] Support jackson option (true by default) Oct 27, 2025
@wing328
Copy link
Member

wing328 commented Oct 27, 2025

did a test to confirm the fix

diff --git a/src/gen/java/org/openapitools/model/User.java b/src/gen/java/org/openapitools/model/User.java
index 11fe24e..1c15bf5 100644
--- a/src/gen/java/org/openapitools/model/User.java
+++ b/src/gen/java/org/openapitools/model/User.java
@@ -7,17 +7,13 @@ import javax.validation.Valid;

 import io.swagger.annotations.*;
 import java.util.Objects;
-import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.annotation.JsonCreator;
-import com.fasterxml.jackson.annotation.JsonValue;
-import com.fasterxml.jackson.annotation.JsonTypeName;

 /**
  * A User who is purchasing from the pet store
  **/
 @ApiModel(description = "A User who is purchasing from the pet store")
-@JsonTypeName("User")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", date = "2025-10-27T09:50:01.567684400+08:00[Asia/Hong_Kong]", comments = "Generator version: 7.17.0-SNAPSHOT")
+
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", date = "2025-10-27T09:50:34.189775500+08:00[Asia/Hong_Kong]", comments = "Generator version: 7.17.0-SNAPSHOT")
 public class User   {
   private Long id;
   private String username;
@@ -40,12 +36,11 @@ public class User   {


   @ApiModelProperty(value = "")
-  @JsonProperty("id")
+
   public Long getId() {
     return id;
   }

-  @JsonProperty("id")
   public void setId(Long id) {
     this.id = id;
   }

@wing328 wing328 merged commit 808d106 into OpenAPITools:master Oct 27, 2025
29 of 33 checks passed
@rignicat rignicat deleted the remove-jackson-requirement branch October 27, 2025 13:19
nscuro added a commit to DependencyTrack/hyades-apiserver that referenced this pull request Oct 30, 2025
@nscuro
Fix v2 resources not being discovered after openapi-generator update
ebf21e1 
As of v7.17.0 of the generator, `@Path` annotations are no longer added at the interface-level: OpenAPITools/openapi-generator#22169

Without them, Jersey can not discover them anymore. Add the annotations on the implementing classes to restore correct discovery.

Signed-off-by: nscuro <[email protected]>
@Sgitario Sgitario mentioned this pull request Nov 4, 2025
Open
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wing328 wing328 wing328 left review comments

Assignees

No one assigned

Labels

Enhancement: Feature Server: Java

Projects

None yet

Milestone

7.17.0

Development

Successfully merging this pull request may close these issues.

[REQ] New Jakarta+Eclipse JAX-RS templates

2 participants

@rignicat @wing328